package org.maxgroundstation.groundstation.comm.service.gps;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

/**
 * Holds information about a particular point of interest location.
 * @author Scott Davis
 * 
 * Copyright (C) 2010  Scott Davis
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
public class PointOfInterest {

    // Data members.
    private String name;
    private String description;
    private double latitude;
    private double longitude;
    private Date timestamp;
    private List<String> snapshotFileNames;
    
    /**
     * Constructor
     */
    public PointOfInterest() {
        // Initialize data members.
        name = "";
        description = "";
        latitude = 0D;
        longitude = 0D;
        timestamp = null;
        snapshotFileNames = new ArrayList<String>();
    }

    /**
     * Gets the name of the point of interest.
     * @return name
     */
    public String getName() {
        return name;
    }

    /**
     * Sets the name of the point of interest.
     * @param name the name
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Gets the description.
     * @return description.
     */
    public String getDescription() {
        return description;
    }

    /**
     * Sets the description.
     * @param description the description.
     */
    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * Gets the latitude location.
     * @return latitude (degrees).
     */
    public double getLatitude() {
        return latitude;
    }

    /**
     * Sets the latitude location.
     * @param latitude (degrees).
     */
    public void setLatitude(double latitude) {
        this.latitude = latitude;
    }

    /**
     * Gets the longitude location.
     * @return longitude (degrees).
     */
    public double getLongitude() {
        return longitude;
    }

    /**
     * Sets the longitude location
     * @param longitude (degrees).
     */
    public void setLongitude(double longitude) {
        this.longitude = longitude;
    }

    /**
     * Gets the time stamp when the point of interest was recorded.
     * @return time stamp.
     */
    public Date getTimestamp() {
        return timestamp;
    }

    /**
     * Sets the time stamp when the point of interest was recorded.
     * @param timestamp the time stamp.
     */
    public void setTimestamp(Date timestamp) {
        this.timestamp = timestamp;
    }
    
    /**
     * Gets all of the file names of video snap shots.
     * @return list of file names.
     */
    public List<String> getSnapshotFileNames() {
        return new ArrayList<String>(snapshotFileNames);
    }
    
    /**
     * Adds a file name for a video snap shot.
     * @param fileName the file name.
     */
    public void addSnapshotFileName(String fileName) {
        snapshotFileNames.add(fileName);
    }
}